Clarify download_fileobj flush guidance in docs#4736
Open
ReinerBRO wants to merge 1 commit intoboto:developfrom
Open
Clarify download_fileobj flush guidance in docs#4736ReinerBRO wants to merge 1 commit intoboto:developfrom
ReinerBRO wants to merge 1 commit intoboto:developfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
download_fileobjdocstrings (client, bucket, object) about callingflush()andseek(0)before reading from the same file objectdownload_fileobjexample showingflush()+seek(0)in awb+contextWhy
Issue #1304 highlights that managed multipart downloads can leave the writable file object in a state where immediate reads may appear incomplete unless callers flush and reset the cursor. This PR documents that usage pattern where users are most likely to look for it.
Validation
python -m pytest tests/unit/s3/test_inject.py -qpython -m ruff check boto3/s3/inject.py(Attempted
sphinx -b dummydocs build locally, but full dummy build stalled in this environment; changes are limited to docstrings and one guide page.)Fixes #1304